home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / com / othernet / fidonet / spot_132 / doc / jetmail.doc / fido_msg.h < prev    next >
C/C++ Source or Header  |  1994-02-17  |  3KB  |  100 lines
  1. /*
  2.  * FIDO_MSG.H
  3.  *
  4.  * header-module for special messages for FIDO software;
  5.  *
  6.  * It's possible to send some fido programs messages, so they will
  7.  * do certain things as soon as possible. Just send a message via 
  8.  * appl_write():
  9.  *
  10.  * WORD message[8], id;
  11.  *
  12.  * id = appl_find( "SEMPER    " );        // or "AVALON  " or "OCTOPUS "
  13.  *
  14.  * if (id>=0)
  15.  * {
  16.  *       message[0] = FIDO_MSG;            // MAGIC value
  17.  *       message[1] = ap_id;                // appl_init ID of the sender
  18.  *       message[2] = 0;                    // just a 16 byte message
  19.  *       *((LONG *) &message[3]) = FROM;    // Sender verification
  20.  *       *((LONG *) &message[5]) = TODO;    // what's to be done
  21.  *       message[7] = 0;                    // reserved
  22.  *
  23.  *       appl_write( id, 16, message );
  24.  * }
  25.  *
  26.  * Make sure that _all_ applications with the same name are getting
  27.  * the needed information!! Within a multitasking environment check
  28.  * for the appl_search() function and use this one instead of appl_find()!!
  29.  *
  30.  * Code to check this is available here if necessary.
  31.  */
  32.  
  33. #ifndef __FIDO_MSG_H__
  34. #define __FIDO_MSG_H__
  35.  
  36. /*--- includes                ---*/
  37.  
  38. /*--- defines                ---*/
  39.  
  40. /*
  41.  * Magic value for recognizing incoming messages:
  42.  */
  43. #define     FIDO_MSG        'FM'        /* Magic value for identifying            */
  44. #define        FIDO_HELLO        '=?-/'        /* For handshake purpose (if necessary)    */
  45. #define        FIDO_HELLO_ACK    '=:-)'        /* Handshake acknowledge                */
  46.  
  47. /*
  48.  * ID's for the 'FROM'-field:
  49.  */
  50. #define     FM_SEMPER        'SEMP'        /* Semper            */
  51. #define     FM_AVALON        'AVAL'        /* Avalon shell     */
  52. #define     FM_MSGREADER    'MSGR'        /* e.g. LED         */
  53. #define     FM_TOSSER        'TOSS'        /* e.g. JetMail     */
  54. #define     FM_REQCOMPILER    'REQC'        /* RequestCompiler    */
  55. #define     FM_NLCOMPILER    'NLST'        /* NodelistCompiler */
  56. #define     FM_OCTOPUS        'OCTP'        /* Octopus BBS        */
  57.  
  58. /*
  59.  * Currently supported SEMPER-TODO values:
  60.  */
  61. #define     SEMP_RESCAN     (1UL << 0)    /* Rescan outbound                */
  62. #define     SEMP_READ_NLIST (1UL << 1)    /* Reread nodelist                */
  63. #define     SEMP_READ_RQST    (1UL << 2)    /* Reread request index         */
  64. #define     SEMP_EXPORTER    (1UL << 3)    /* Executes the Export program    */
  65.  
  66. /*
  67.  * Currently supported AVALON-TODO values:
  68.  */
  69. #define      AVAL_REQ        1UL       /* FileRequest                  */
  70. #define      AVAL_HATCH     2UL       /* FileHatch                      */
  71. #define      AVAL_FIX        3UL       /* Areafix                      */
  72. #define      AVAL_AREAS     4UL       /* Edit areas                   */
  73.  
  74. /*
  75.  * Currently supported OCTOPUS-TODO values:
  76.  */
  77. #define OCTO_M_LOCAL     0x0001UL  /* Begin a local logon                          */
  78. #define OCTO_M_WATCH     0x0002UL  /* Open a View window when a connection exist  */
  79. #define OCTO_M_MAILER     0x0004UL  /* End Octopus after a connection (not needed) */
  80. #define OCTO_M_NOHANGUP  0x0008UL  /* Don't raise the DTR signal for hangup       */
  81. #define OCTO_M_STATUS     0x0010UL  /* Request of Octopus Status                      */
  82.  
  83. /*
  84.  * Return values for Octopus->Semper:
  85.  */
  86.  
  87. #define OCTO_M_OK         0x0010UL  /* Ok, ACK handshake message         */
  88. #define OCTO_M_BUSY      0x0020UL  /* Octopus is busy yet                */
  89. #define OCTO_M_READY     0x0040UL  /* Octopus is waiting (ready) now... */
  90. #define OCTO_M_HELLO     0x0080UL  /* Say Hello to Semper... :-)        */
  91.  
  92. /*--- types                 ---*/
  93.  
  94. /*--- variables             ---*/
  95.  
  96. /*--- prototypes            ---*/
  97.  
  98. /*--- End of fido_msg.h module    ---*/
  99. #endif
  100.